FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package hl7.fhir.uv.cmi#current (32 ms)

Package hl7.fhir.uv.cmi
Type OperationDefinition
Id Id
FHIR Version R4
Source http://hl7.org/fhir/uv/cmi/https://build.fhir.org/ig/HL7/Content-Management-Infrastructure-IG/OperationDefinition-Library-data-requirements.html
Url http://hl7.org/fhir/uv/cmi/OperationDefinition/Library-data-requirements
Version 0.1.0
Status draft
Date 2019-11-01T09:29:23+11:00
Name LibraryDataRequirements
Title Library Data Requirements
Experimental False
Realm uv
Authority hl7
Description Determines the effective data requirements for the library, including known components and dependencies, and optionally informed by a version manifest.
Type true
Kind operation

Resources that use this resource

CapabilityStatement
publishable-measure-repository CQF Measures Publishable Measure Repository Capability Statement

Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

LibraryDataRequirements

OPERATION: LibraryDataRequirements

The official URL for this operation definition is:

http://hl7.org/fhir/uv/cmi/OperationDefinition/Library-data-requirements

Determines the effective data requirements for the library, including known components and dependencies, and optionally informed by a version manifest.

URL: [base]/Library/$data-requirements

URL: [base]/Library/[id]/$data-requirements

Parameters

UseNameCardinalityTypeBindingDocumentation
INid0..1string

The logical id of the library to analyze. The server must know the library (e.g. it is defined explicitly in the server's libraries)

INurl0..1uri

A canonical reference to a library. The server must know the library (e.g. it is defined explicitly in the server's libraries

INversion0..1string

The version of the library to analyze

INidentifier0..1string
(token)

A business identifier of the library to be analyzed. The server must know the library and the identifier must resolve unambiguously to a single library on the server.

INexpression0..*string

The name of a specific expression to be considered for analysis. If no expressions are specified, the analysis is performed on the entire library. If expressions are specified, the analysis is performed only on the expressions specified.

INparameters0..1Parameters

Any input parameters for the artifact. Parameters defined in this input will be bound by name to parameters defined in the CQL library (or referenced libraries). Parameter types are mapped to CQL as specified in the Using CQL section of this implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.

INsystem-version0..*canonical

Specifies a version to use for a system, if the library or value set does not already specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56

INcheck-system-version0..*canonical

Edge Case: Specifies a version to use for a system. If a library or value set specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56

INforce-system-version0..*canonical

Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the library and value sets (and any it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the value is override, the version used SHALL explicitly be represented in the expansion parameters

INmanifest0..1canonical

Specifies an asset-collection library that defines version bindings for code systems referenced by value set(s) or other artifacts used in the artifact. When specified, code systems identified as depends-on related artifacts in the library have the same meaning as specifying that code system version in the system-version parameter.

INinclude-dependencies0..1boolean

Specifies whether to follow known dependencies of the artifact as part of the analysis, recursively (default = true)

INinclude-components0..1boolean

Specifies whether to follow known components of the artifact as part of the analysis, recursively (default = true)

OUTreturn1..1Bundle

The result of the requirements operation is a module-definition Library that returns the computed effective requirements of the artifact.

The requirements operation supports the ability of a repository to determine the effective requirements of an artifact, including terminology usage (code systems, value sets, and direct-reference codes), parameters, dependencies (artifacts), and data requirements


Source

{
  "resourceType" : "OperationDefinition",
  "id" : "Library-data-requirements",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>LibraryDataRequirements</h2><p>OPERATION: LibraryDataRequirements</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/uv/cmi/OperationDefinition/Library-data-requirements</pre><div><p>Determines the effective data requirements for the library, including known components and dependencies, and optionally informed by a version manifest.</p>\n</div><p>URL: [base]/Library/$data-requirements</p><p>URL: [base]/Library/[id]/$data-requirements</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>id</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The logical id of the library to analyze. The server must know the library (e.g. it is defined explicitly in the server's libraries)</p>\n</div></td></tr><tr><td>IN</td><td>url</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>A canonical reference to a library. The server must know the library (e.g. it is defined explicitly in the server's libraries</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The version of the library to analyze</p>\n</div></td></tr><tr><td>IN</td><td>identifier</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>A business identifier of the library to be analyzed. The server must know the library and the identifier must resolve unambiguously to a single library on the server.</p>\n</div></td></tr><tr><td>IN</td><td>expression</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The name of a specific expression to be considered for analysis. If no expressions are specified, the analysis is performed on the entire library. If expressions are specified, the analysis is performed only on the expressions specified.</p>\n</div></td></tr><tr><td>IN</td><td>parameters</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/parameters.html\">Parameters</a></td><td/><td><div><p>Any input parameters for the artifact. Parameters defined in this input will be bound by name to parameters defined in the CQL library (or referenced libraries). Parameter types are mapped to CQL as specified in the Using CQL section of this implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.</p>\n</div></td></tr><tr><td>IN</td><td>system-version</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Specifies a version to use for a system, if the library or value set does not already specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56</p>\n</div></td></tr><tr><td>IN</td><td>check-system-version</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a system. If a library or value set specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56</p>\n</div></td></tr><tr><td>IN</td><td>force-system-version</td><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the library and value sets (and any it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the value is override, the version used SHALL explicitly be represented in the expansion parameters</p>\n</div></td></tr><tr><td>IN</td><td>manifest</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>Specifies an asset-collection library that defines version bindings for code systems referenced by value set(s) or other artifacts used in the artifact. When specified, code systems identified as <code>depends-on</code> related artifacts in the library have the same meaning as specifying that code system version in the <code>system-version</code> parameter.</p>\n</div></td></tr><tr><td>IN</td><td>include-dependencies</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Specifies whether to follow known dependencies of the artifact as part of the analysis, recursively (default = true)</p>\n</div></td></tr><tr><td>IN</td><td>include-components</td><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Specifies whether to follow known components of the artifact as part of the analysis, recursively (default = true)</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The result of the requirements operation is a <em>module-definition</em> Library that returns the computed effective requirements of the artifact.</p>\n</div></td></tr></table><div><p>The requirements operation supports the ability of a repository to determine the effective requirements of an artifact, including terminology usage (code systems, value sets, and direct-reference codes), parameters, dependencies (artifacts), and data requirements</p>\n</div></div>"
  },
  "url" : "http://hl7.org/fhir/uv/cmi/OperationDefinition/Library-data-requirements",
  "version" : "0.1.0",
  "name" : "LibraryDataRequirements",
  "title" : "Library Data Requirements",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2019-11-01T09:29:23+11:00",
  "publisher" : "Clinical Decision Support WG",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "Determines the effective data requirements for the library, including known components and dependencies, and optionally informed by a version manifest.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "code" : "data-requirements",
  "comment" : "The requirements operation supports the ability of a repository to determine the effective requirements of an artifact, including terminology usage (code systems, value sets, and direct-reference codes), parameters, dependencies (artifacts), and data requirements",
  "resource" : [
    "Library"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "id",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The logical id of the library to analyze. The server must know the library (e.g. it is defined explicitly in the server's libraries)",
      "type" : "string"
    },
    {
      "name" : "url",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A canonical reference to a library. The server must know the library (e.g. it is defined explicitly in the server's libraries",
      "type" : "uri"
    },
    {
      "name" : "version",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The version of the library to analyze",
      "type" : "string"
    },
    {
      "name" : "identifier",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A business identifier of the library to be analyzed. The server must know the library and the identifier must resolve unambiguously to a single library on the server.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "expression",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The name of a specific expression to be considered for analysis. If no expressions are specified, the analysis is performed on the entire library. If expressions are specified, the analysis is performed only on the expressions specified.",
      "type" : "string"
    },
    {
      "name" : "parameters",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Any input parameters for the artifact. Parameters defined in this input will be bound by name to parameters defined in the CQL library (or referenced libraries). Parameter types are mapped to CQL as specified in the Using CQL section of this implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL.",
      "type" : "Parameters"
    },
    {
      "name" : "system-version",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Specifies a version to use for a system, if the library or value set does not already specify which one to use. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56",
      "type" : "canonical"
    },
    {
      "name" : "check-system-version",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Edge Case: Specifies a version to use for a system. If a library or value set specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56",
      "type" : "canonical"
    },
    {
      "name" : "force-system-version",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Edge Case: Specifies a version to use for a system. This parameter overrides any specified version in the library and value sets (and any it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the value is override, the version used SHALL explicitly be represented in the expansion parameters",
      "type" : "canonical"
    },
    {
      "name" : "manifest",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Specifies an asset-collection library that defines version bindings for code systems referenced by value set(s) or other artifacts used in the artifact. When specified, code systems identified as `depends-on` related artifacts in the library have the same meaning as specifying that code system version in the `system-version` parameter.",
      "type" : "canonical"
    },
    {
      "name" : "include-dependencies",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Specifies whether to follow known dependencies of the artifact as part of the analysis, recursively (default = true)",
      "type" : "boolean"
    },
    {
      "name" : "include-components",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Specifies whether to follow known components of the artifact as part of the analysis, recursively (default = true)",
      "type" : "boolean"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The result of the requirements operation is a _module-definition_ Library that returns the computed effective requirements of the artifact.",
      "type" : "Bundle"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.